/*
 * Copyright 2025 arisgo@163.com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.arisgo.cloud.auth.sys.vo;

import com.arisgo.cloud.web.model.NumberId;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;

/**
 * 行政区划表
 *
 * @author Arisgo
 * @since 2024-06-14
 */
@Data
@Schema(description = "行政区划表信息")
public class RegionVo extends NumberId {

    /**
     * 区划编号
     */
    @Schema(name = "code", description = "区划编号")
    private String code;

    /**
     * 父区划编号
     */
    @Schema(name = "parentCode", description = "父区划编号")
    private String parentCode;

    /**
     * 祖区划编号
     */
    @Schema(name = "ancestors", description = "祖区划编号")
    private String ancestors;

    /**
     * 区划名称
     */
    @Schema(name = "name", description = "区划名称")
    private String name;

    /**
     * 省级区划编号
     */
    @Schema(name = "provinceCode", description = "省级区划编号")
    private String provinceCode;

    /**
     * 省级名称
     */
    @Schema(name = "provinceName", description = "省级名称")
    private String provinceName;

    /**
     * 市级区划编号
     */
    @Schema(name = "cityCode", description = "市级区划编号")
    private String cityCode;

    /**
     * 市级名称
     */
    @Schema(name = "cityName", description = "市级名称")
    private String cityName;

    /**
     * 区级区划编号
     */
    @Schema(name = "districtCode", description = "区级区划编号")
    private String districtCode;

    /**
     * 区级名称
     */
    @Schema(name = "districtName", description = "区级名称")
    private String districtName;

    /**
     * 镇级区划编号
     */
    @Schema(name = "townCode", description = "镇级区划编号")
    private String townCode;

    /**
     * 镇级名称
     */
    @Schema(name = "townName", description = "镇级名称")
    private String townName;

    /**
     * 村级区划编号
     */
    @Schema(name = "villageCode", description = "村级区划编号")
    private String villageCode;

    /**
     * 村级名称
     */
    @Schema(name = "villageName", description = "村级名称")
    private String villageName;

    /**
     * 层级
     */
    @Schema(name = "level", description = "层级")
    private Integer level;

    /**
     * 排序
     */
    @Schema(name = "sort", description = "排序")
    private Integer sort;

    /**
     * 备注
     */
    @Schema(name = "remark", description = "备注")
    private String remark;

}
